| Package | hl7.fhir.us.sdoh-clinicalcare |
| Type | CapabilityStatement |
| Id | Id |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/sdoh-clinicalcare/https://build.fhir.org/ig/HL7/fhir-sdoh-clinicalcare/CapabilityStatement-SDOHCC-ReferralRecipient.html |
| Url | http://hl7.org/fhir/us/sdoh-clinicalcare/CapabilityStatement/SDOHCC-ReferralRecipient |
| Version | 2.2.0 |
| Status | active |
| Date | 2021-06 |
| Name | SDOHCC_ReferralRecipient |
| Title | SDOHCC Referral Recipient |
| Experimental | False |
| Realm | us |
| Authority | hl7 |
| Description | This resource describes the required and desired behavior of systems acting as SDOH clinical care 'referral recipients'. These are typically community-based organizations that can provide services such as food bank access, housing remediation, etc. |
| Purpose | In some cases, a referral recipient might actually further refer the patient to a downstream service provider through non-FHIR means. In such cases, the system is still treated as a 'referral recipient' rather than a [Coordination Platform](CapabilityStatement-SDOHCC-CoordinationPlatform.html) because, from a FHIR interface perspective, the referral process 'stops' with that system. Referral recipients must be able to receive or monitor for Tasks issued by [Referral Sources](CapabilityStatement-SDOHCC-ReferralSource.html) and [Coordination Platforms](CapabilityStatement-SDOHCC-CoordinationPlatform.html). They must also be able to respond to access the ServiceRequest representing the referral pointed to by the Task and any relevant information referenced by the referral, update the Task with their acceptance or rejection of the referral, and finally provide information about what interventions were actually performed using the Procedure resource.\n\n There are actually two types of referral recipients defined in this implementation guide. This CapabilityStatement describes the expected behavior of more sophisticated service delivery systems that are capable of exposing a FHIR service and persisting Tasks and Procedures in their own environment. A separate set of interface expectations is defined for ['Light' Referral Recipients](CapabilityStatement-SDOHCC-ReferralRecipientLight.html) that are not capable of exposing an endpoint and where the Task and any resulting Procedures must be stored in the requesting system's database. |
| Kind | requirements |
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement SDOHCC-ReferralRecipient
FHIR
xml, jsonNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
clientThe clinical care referral recipient needs to access information from and update information in SDOH clinical care referral sources and/or coordination platforms that have solicited the filling of SDOH-related referrals by this system
SMART-on-FHIRImplementations must meet the general privacy & security requirements documented in this implementation guide.
batchinteraction described as follows:Allows polling for changes to multiple resource types simultaneously
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| CareTeam | Supported Profiles US Core CareTeam Profile | y | y | _id, _lastUpdated | |||||
| Condition | Supported Profiles SDOHCC Condition | y | y | _id, _lastUpdated, category, clinical-status, code, patient, verification-status | |||||
| Consent | Supported Profiles SDOHCC Consent | y | y | _id, _lastUpdated, source-reference | Consent:source-reference:DocumentReference | ||||
| Device | Supported Profiles Device | y | y | _id, _lastUpdated | |||||
| DocumentReference | Supported Profiles US Core DocumentReference Profile | y | y | _id, _lastUpdated | |||||
| Goal | Supported Profiles SDOHCC Goal | y | y | _id, _lastUpdated, achievement-status, category, lifecycle-status, patient, target-date | |||||
| HealthcareService | Supported Profiles SDOHCC Healthcare Service | y | y | _id, _lastUpdated, location | |||||
| Location | Supported Profiles SDOHCC Location | y | y | _id, _lastUpdated | |||||
| Observation | Supported Profiles SDOHCC Observation Assessment SDOHCC Observation Screening Response SDOHCC Observation Ethnicity OMB SDOHCC Observation Race OMB SDOHCC Observation Gender Identity SDOHCC Observation Personal Characteristic SDOHCC Observation Personal Pronouns SDOHCC Observation Recorded Sex Gender SDOHCC Observation Sexual Orientation | y | y | _id, _lastUpdated, category, code, code-value-concept, date, derived-from, patient, status | |||||
| Organization | Supported Profiles US Core Organization Profile | y | y | _id, _lastUpdated | |||||
| Patient | Supported Profiles US Core Patient Profile | y | y | _id, _lastUpdated | |||||
| Practitioner | Supported Profiles US Core Practitioner Profile | y | y | _id, _lastUpdated | |||||
| PractitionerRole | Supported Profiles US Core PractitionerRole Profile | y | y | _id, _lastUpdated, organization, practitioner | PractitionerRole:organization, PractitionerRole:practitioner | ||||
| Procedure | Supported Profiles SDOHCC Procedure | y | y | y | y | _id, _lastUpdated, based-on, category, code, date, patient, performer, status | |||
| RelatedPerson | Supported Profiles RelatedPerson | y | y | _id, _lastUpdated | |||||
| ServiceRequest | Supported Profiles SDOHCC ServiceRequest | y | y | _id, _lastUpdated, category, code, intent, occurrence, patient, performer, requester, status, supporting-info | HealthCareService:location, ServiceRequest:supporting-info, ServiceRequest:pertains-to-goal, ServiceRequest:patient, ServiceRequest:requester, ServiceRequest:performer, PractitionerRole:practitioner, PractitionerRole:organization | ||||
| Subscription | Supported Profiles R4/B Topic-Based Subscription | y | y | $status |
literalreadAllows the system to retrieve a CareTeam that is the intended performer of a ServiceRequest.
search-typeAllows the monitoring of previously-retrieved CareTeams that are the intended performer of ServiceRequests.
For referral sources that receive referrals from upstream systems, used to access information about the intended performer of a ServiceRequest when the performer is a specific team of people. Note: Conformance expectations for this resource are lower because CareTeam performers are expected to be uncommon in most SDOH uses
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieving known CareTeam records - and more specifically, retrieving more than one in a single call to poll for updates |
| SHOULD | _lastUpdated | date | Allows filtering for only records that have changed since last query |
literalreadAllows the system to retrieve a Condition that is the reason for a ServiceRequest.
search-typeAllows the monitoring of previously-retrieved Conditions that are referenced by ServiceRequests.
For referral sources that receive referrals from upstream systems, used to access information about a patient's SDOH-related conditions, particularly those that are the reason for a referral
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieving known Condition records - and more specifically, retrieving more than one in a single call to poll for updates |
| SHALL | category | token | Allows filtering to only SDOH-related conditions |
| SHALL | patient | reference | Allows filtering to only conditions associated with a specific patient. Some systems will require that searches be patient-specific |
| SHOULD | _lastUpdated | date | Allows filtering for only records that have changed since last query |
| SHOULD | clinical-status | token | Allows filtering to only active conditions |
| SHOULD | code | token | Allows filtering to only specific SDOH conditions or sets of conditions |
| SHOULD | verification-status | token | Allows filtering to exclude refuted or entered-in-error conditions |
literalreadAllows the system to retrieve a Consent referenced as a 'supportingInformation' item of a ServiceRequest.
search-typeAllows the monitoring of previously-retrieved Consents related to ServiceRequests of interest.
Used to access the consent that authorizes disclosure of ServiceRequest information to non-HIPAA-covered entities
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieving known consent records - and more specifically, retrieving more than one in a single call to poll for updates |
| SHALL | source-reference | reference | Allows including the document that contains the PDF or similar representation of a paper consent |
| SHOULD | _lastUpdated | date | Allows filtering for only records that have changed since last query |
literalreadAllows the system to retrieve a Device that is the requester or intended performer of a ServiceRequest.
search-typeAllows the monitoring of previously-retrieved Devices that are the requester or intended performer of ServiceRequests.
Used to retrieve the requester or intended performer of an SDOH ServiceRequest. Note: Conformance expectations for this resource are lower because Device requesters and performers are expected to be uncommon in most SDOH uses
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieving known Device records - and more specifically, retrieving more than one in a single call to poll for updates |
| SHOULD | _lastUpdated | date | Allows filtering for only records that have changed since last query |
literalreadAllows the system to retrieve a PDF or similar content referenced by a Consent or Task.
search-typeAllows the monitoring of previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated.
Used to retrieve a scanned or other form of document representing the text of a consent. Also used for PDF forms.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates |
| SHOULD | _lastUpdated | date | Allows filtering for only records that have changed since last query |
literalreadAllows the system to retrieve a goal referenced by a ServiceRequest.
search-typeAllows the monitoring of previously-retrieved Goals in the event they are updated.
Used to access goals related to an SDOH referral
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieving known Goal records - and more specifically, retrieving more than one in a single call to poll for updates |
| SHALL | category | token | Allows filtering to only include SDOH-related goals |
| SHALL | patient | reference | Allows filtering to only include goals for a particular patient. Some systems will require searches to be patient-specific |
| SHOULD | _lastUpdated | date | Allows filtering for only records that have changed since last query |
| SHOULD | achievement-status | token | Allows filtering to only include unmet goals |
| SHOULD | lifecycle-status | token | Allows filtering to only include active goals |
| SHOULD | target-date | date | Allows filtering based on when a particular goal is desired to be achieved |
literalreadAllows the system to retrieve a HealthcareService that is the intended performer of a ServiceRequest.
search-typeAllows the monitoring of previously-retrieved HealthcareServices that are the intended performer of ServiceRequests.
For referral sources that receive referrals from upstream systems, used to access information about the intended performer of a ServiceRequest when the performer is a specific service within a larger facility. Also used to indicate who a patient or caregiver should contact about a particular service.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieving known HealthcareService records - and more specifically, retrieving more than one in a single call to poll for updates |
| SHALL | location | reference | Allows retrieval of the phyical site(s) associated with a HealthService |
| SHOULD | _lastUpdated | date | Allows filtering for only records that have changed since last query |
literalreadAllows the system to retrieve a Location that is an available location for a service.
search-typeAllows the monitoring of previously-retrieved Locations that are the intended locations for services.
Used to access information about the potential sites at which a requested service might be performed. Allows a patient to evaluate the suitability of a proposed activity or service.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieving known Location records - and more specifically, retrieving more than one in a single call to poll for updates |
| SHOULD | _lastUpdated | date | Allows filtering for only records that have changed since last query |
literalreadAllows the system to retrieve an Observation referenced by a ServiceRequest.
search-typeAllows the monitoring of previously-retrieved Observations for updates/corrections.
SDOHCC Observation Assessment
SDOHCC Observation Screening Response
SDOHCC Observation Ethnicity OMB
SDOHCC Observation Race OMB
SDOHCC Observation Gender Identity
SDOHCC Observation Personal Characteristic
SDOHCC Observation Personal Pronouns
SDOHCC Observation Recorded Sex Gender
SDOHCC Observation Sexual Orientation
For referral sources that receive referrals from upstream systems, used to access information about SDOH-related observations for a patient - particularly those that are reasons for a referral as well as certain SDOH-relevant demographic information
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieving known Observation records - and more specifically, retrieving more than one in a single call to poll for updates |
| SHALL | category | token | Allows filtering for only SDOH-related observations |
| SHALL | patient | reference | Allows filtering for observations specific to a particular patient. Some systems will require that all queries be patient-specific |
| SHALL | status | token | Allows filtering for observations that are completed or revised (i.e. not in-progress or entered-in-error) |
| SHOULD | _lastUpdated | date | Allows filtering for only records that have changed since last query |
| SHOULD | code | token | Allows filtering for specific types of observations |
| SHOULD | date | date | Allows filtering for observations that held in a particular time period |
| SHOULD | derived-from | reference | Allows filtering for observations derived from a particular QuestionnaireResponse |
| MAY | code-value-concept | composite | Allows filtering for observations that have a specific coded value answer for a specified observation type |
literalreadAllows the system to retrieve an Organization that is the requester or intended performer of a ServiceRequest.
search-typeAllows the monitoring of previously-retrieved Organizations that are the requester or intended performer of ServiceRequests.
For referral sources that receive referrals from upstream systems, used to access information about an Organization that is the requester or intended performer of a ServiceRequest
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieving known Organization records - and more specifically, retrieving more than one in a single call to poll for updates |
| SHOULD | _lastUpdated | date | Allows filtering for only records that have changed since last query |
literalreadAllows the system to retrieve the Patient that is the subject of a ServiceRequest.
search-typeAllows the monitoring of previously-retrieved Patients.
For referral sources that receive referrals from upstream systems, used to access information about the Patient that is the subject a ServiceRequest
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieving known Patient records - and more specifically, retrieving more than one in a single call to poll for updates |
| SHOULD | _lastUpdated | date | Allows filtering for only records that have changed since last query |
literalreadAllows the system to retrieve a Practitioner that is the requester or intended performer of a ServiceRequest.
search-typeAllows the monitoring of previously-retrieved Practitioners that are the requester or intended performer of ServiceRequests.
For referral sources that receive referrals from upstream systems, used to access information about an Practitioner that is the requester or intended performer of a ServiceRequest
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieving known Practitioner records - and more specifically, retrieving more than one in a single call to poll for updates |
| SHOULD | _lastUpdated | date | Allows filtering for only records that have changed since last query |
literalreadAllows the system to retrieve a PractitionerRole that is the requester or intended performer of a ServiceRequest.
search-typeAllows the monitoring of previously-retrieved PractitionerRoles that are the requester or intended performer of ServiceRequests.
For referral sources that receive referrals from upstream systems, used to access information about an PractitionerRole that is the requester or intended performer of a ServiceRequest
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieving known PractitionerRole records - and more specifically, retrieving more than one in a single call to poll for updates |
| SHOULD | _lastUpdated | date | Allows filtering for only records that have changed since last query |
| SHOULD | organization | reference | Allows doing an _include on Organization when retrieving the PractitionerRole |
| SHOULD | practitioner | reference | Allows doing an _include on Practitioner when retrieving the PractitionerRole |
literalcreateAllows the system to write records of procedures done in response to a referral on the system that asked for the referral.
updateAllows the system to update records of procedures done in response to a referral on the system that asked for the referral.
readAllows the referral recipient to retrieve procedures referenced by Tasks previously posted.
search-typeAllows the referral recipient to check if others have updated (e.g. added comments) to procedures previously posted and/or to find previously submitted procedures so they can be rendered to a user.
Used to record information about actions that have been performed as a result of a referral
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieving known Procedure records - and more specifically, retrieving more than one in a single call to poll for updates |
| SHALL | based-on | reference | Allows filtering for procedures resulting from a particular service request |
| SHALL | category | token | Allows filtering for procedures that are SDOH-related |
| SHALL | patient | reference | Allows filtering for procedures based on who they were delivered to. Some systems may require that all searches be patient-specific. |
| SHALL | performer | reference | Allows filtering for procedures based on who delivered the procedure. |
| SHALL | status | token | Allows filtering for procedures that are complete or in progress |
| SHOULD | _lastUpdated | date | Allows filtering for only records that have changed since last query |
| SHOULD | code | token | Allows filtering for procedures based on the specific service delivered |
| SHOULD | date | date | Allows filtering for procedures based on when they were delivered |
literalreadAllows the system to retrieve a RelatedPerson that is the requester or intended performer of a ServiceRequest.
search-typeAllows the monitoring of previously-retrieved RelatedPersons that are the requester or intended performer of ServiceRequests.
For referral sources that receive referrals from upstream systems, used to access information about the requester or intended performer of a ServiceRequest when they are someone with a personal relationship to the Patient. Note: Conformance expectations for this resource are lower because CareTeam performers are expected to be uncommon in most SDOH uses
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieving known RelatedPerson records - and more specifically, retrieving more than one in a single call to poll for updates |
| SHOULD | _lastUpdated | date | Allows filtering for only records that have changed since last query |
literalreadAllows client systems to retrieve the ServiceRequest pointed to by a Task.
search-typeAllows client systems to monitor multiple ServiceRequests for change simultaneously via polling.
For referral sources that receive referrals from upstream systems, used to retrieve an order for SDOH-related services
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieving known ServiceRequests records - and more specifically, retrieving more than one in a single call to poll for updates |
| SHALL | category | token | Allows filtering to only retrieve ServiceRequests that are SDOH-related |
| SHALL | intent | token | Allows filtering to retrieve only 'order' ServiceRequests and not plans, proposals, etc. |
| SHALL | patient | reference | Allows filtering to retrieve only ServiceRequests associated with a particular patient. Note that some systems may mandate that searches are always patient-specific |
| SHALL | status | token | Allows filtering to retrieve only active ServiceRequests |
| SHOULD | _lastUpdated | date | Allows filtering for only records that have changed since last query |
| SHOULD | code | token | Allows filtering to retrieve ServiceRequests for specific types of services |
| SHOULD | occurrence | date | Allows filtering to retrieve ServiceRequests based on the timeframe in which the service needs to be provided |
| SHOULD | performer | reference | Allows filtering to retrieve only ServiceRequests that designate a specific performer |
| SHOULD | requester | reference | Allows filtering to retrieve only ServiceRequests created by a specific practitioner |
| SHOULD | supporting-info | reference | Allows _include to retrieve supporting information for a ServiceRequest - particularly Consent |
createNecessary if using subscriptions to monitor updates to the Task
updateNeeded to allow the requester to update a subscription - to adjust delivery target, to add additional tasks to monitor (if subscribing by id) typically to cancel a request for fulfillment
Used to allow upstream systems to subscribe to and monitor Tasks stored on this system for change
| Conformance | Operation | Documentation |
|---|---|---|
| SHOULD | $status | Necessary for systems supporting subscriptions to ensure that the subscription is functioning properly and to check for errors |
serverThe clinical care referral recipient needs to allow SDOH clinical care referral sources and coordination platforms to have solicited the filling of SDOH-related referrals by this system and also to access Procedures that describe interventions taken by the users of this system.
SMART-on-FHIRImplementations must meet the general privacy & security requirements documented in this implementation guide.
batchinteraction described as follows:Allows other systems to poll for changes to multiple resource types simultaneously
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| DocumentReference | Supported Profiles US Core DocumentReference Profile | y | y | y | y | _id, _lastUpdated | |||
| Subscription | Supported Profiles R4/B Topic-Based Subscription | y | y | $status | |||||
| Task | Supported Profiles SDOHCC Task For Patient SDOHCC Task For Referral Management | y | y | y | y | _id, _lastUpdated, code, owner, patient, requester, status, focus, output | Task:output |
literalcreateAllows the app to record a new PDF (e.g. a completed form)
readAllows patient apps to retrieve a PDF or similar content referenced by a Consent or Task.
search-typeAllows patient apps to monitor previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated.
updateAllows the system to revise a previously stored PDF
Used convey a scanned or other form of document representing the text of a consent. Also used for PDF forms.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates |
| SHOULD | _lastUpdated | date | Allows filtering for only records that have changed since last query |
createAllows upstream systems to initiate a subscription to monitor updates to Tasks (and theoretically other things)
updateAllows upstream systems to revise existing subscriptions - to adjust delivery target, to add additional tasks to monitor (if subscribing by id), etc.
Used to allow upstream coordination platforms and referral sources to subscribe to and monitor Tasks created on this system
| Conformance | Operation | Documentation |
|---|---|---|
| SHOULD | $status | Allows upstream systems to verify their subscription is functioning properly and to check for errors |
literalcreateAllows upstream coordination platforms and referral sources system to create tasks on this system seeking fulfillment of a ServiceRequest or requesting that a patient or caregiver perform certain activities.
updateAllows modification of an existing Task by upstream systems (e.g. to cancel it) or by downstream systems (to accept or reject it or add output links to performed procedures). ReferralRecipients can freely modify any Tasks they have created (though they should consider the impact of doing so on downstream recipients or the patient). However, if they are not the creator, they SHALL only modify tasks they are the 'owner' of and then, only modify Task.status, Task.statusReason, and Task.outputs are possible, and then only for Tasks where the owner is the patient.
readAllows retrieval of a Task that was referenced in a subscription notification or per-Task polling for change.
search-typeAllows the other systems to poll multiple tasks simultaneously, as well as to retrieve referenced resources as part of a single query.
Used by upstream referral sources and coordination platforms to create and update Tasks seeking fufillment of ServiceRequests. Also used by downstream referral recipiencts to monitor and update Tasks stored on this system as they respond to requests to fulfill referrals and link in information about actions taken so far
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Allows retrieving known Task records - and more specifically, retrieving more than one in a single call to poll for updates |
| SHALL | code | token | Allows filtering for 'fulfill' tasks as opposed to others. Some systems may require code to be included as a filter criteria as different Task codes may correspond to different internal database tables. |
| SHALL | patient | reference | Allows monitoring of tasks associated with a particular patient. (Some systems may require that all queries be done in the context of a single patient.) |
| SHALL | requester | reference | Allows retrieving all tasks that have been requested by a particular organization or individual. This will commonly be used to monitor the tasks initiated by a particular system |
| SHALL | status | token | Allows filtering to only active or completed tasks |
| SHALL | focus | reference | Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest |
| SHOULD | _lastUpdated | date | Allows filtering for only records that have changed since last query |
| SHOULD | owner | reference | Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned) |
| SHOULD | output | reference | Allows for the 'output' of a Task to be included when retrieving a Task |
{
"resourceType" : "CapabilityStatement",
"id" : "SDOHCC-ReferralRecipient",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement SDOHCC-ReferralRecipient</b></p><a name=\"SDOHCC-ReferralRecipient\"> </a><a name=\"hcSDOHCC-ReferralRecipient\"> </a><a name=\"SDOHCC-ReferralRecipient-en-US\"> </a><h2 id=\"title\">SDOHCC Referral Recipient</h2><ul><li>Implementation Guide Version: 2.2.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2021-06 </li><li>Published by: HL7 International / Patient Care </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><h3 id=\"rest1\">REST Configuration: 1 </h3><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"mode1\" class=\"panel-title\">Mode: <code>client</code></h4></div><div class=\"panel-body\"><div><p>The clinical care referral recipient needs to access information from and update information in SDOH clinical care <a href=\"CapabilityStatement-SDOHCC-ReferralSource.html\">referral sources</a> and/or <a href=\"CapabilityStatement-SDOHCC-CoordinationPlatform.html\">coordination platforms</a> that have solicited the filling of SDOH-related referrals by this system</p>\n</div><div class=\"lead\"><em>Security</em></div><div class=\"row\"><div class=\"col-lg-6\">Enable CORS: no</div><div class=\"col-lg-6\">Security services supported: <code>SMART-on-FHIR</code></div></div><blockquote><div><p>Implementations must meet the general privacy & security requirements documented in <a href=\"privacy_and_security.html\">this implementation guide</a>.</p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li><strong>SHOULD </strong>support the <code>batch</code>interaction described as follows:<div><p>Allows polling for changes to multiple resource types simultaneously</p>\n</div></li></ul></div></div><h4 id=\"resourcesCap1\">Capabilities by Resource/Profile</h4><h5 id=\"resourcesSummary1\">Summary</h5><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#CareTeam1-1\">CareTeam</a></td><td>Supported Profiles<br/>��<a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-careteam.html\">US Core CareTeam Profile</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated</td><td/><td/><td/></tr><tr><td><a href=\"#Condition1-2\">Condition</a></td><td>Supported Profiles<br/>��<a href=\"StructureDefinition-SDOHCC-Condition.html\">SDOHCC Condition</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated, category, clinical-status, code, patient, verification-status</td><td/><td/><td/></tr><tr><td><a href=\"#Consent1-3\">Consent</a></td><td>Supported Profiles<br/>��<a href=\"StructureDefinition-SDOHCC-Consent.html\">SDOHCC Consent</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated, source-reference</td><td><code>Consent:source-reference:DocumentReference</code></td><td/><td/></tr><tr><td><a href=\"#Device1-4\">Device</a></td><td>Supported Profiles<br/>��<a href=\"http://hl7.org/fhir/R4/device.html\">Device</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated</td><td/><td/><td/></tr><tr><td><a href=\"#DocumentReference1-5\">DocumentReference</a></td><td>Supported Profiles<br/>��<a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-documentreference.html\">US Core DocumentReference Profile</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated</td><td/><td/><td/></tr><tr><td><a href=\"#Goal1-6\">Goal</a></td><td>Supported Profiles<br/>��<a href=\"StructureDefinition-SDOHCC-Goal.html\">SDOHCC Goal</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated, achievement-status, category, lifecycle-status, patient, target-date</td><td/><td/><td/></tr><tr><td><a href=\"#HealthcareService1-7\">HealthcareService</a></td><td>Supported Profiles<br/>��<a href=\"StructureDefinition-SDOHCC-HealthcareService.html\">SDOHCC Healthcare Service</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated, location</td><td/><td/><td/></tr><tr><td><a href=\"#Location1-8\">Location</a></td><td>Supported Profiles<br/>��<a href=\"StructureDefinition-SDOHCC-Location.html\">SDOHCC Location</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated</td><td/><td/><td/></tr><tr><td><a href=\"#Observation1-9\">Observation</a></td><td>Supported Profiles<br/>��<a href=\"StructureDefinition-SDOHCC-ObservationAssessment.html\">SDOHCC Observation Assessment</a><br/>��<a href=\"StructureDefinition-SDOHCC-ObservationScreeningResponse.html\">SDOHCC Observation Screening Response</a><br/>��<a href=\"StructureDefinition-SDOHCC-ObservationEthnicityOMB.html\">SDOHCC Observation Ethnicity OMB</a><br/>��<a href=\"StructureDefinition-SDOHCC-ObservationRaceOMB.html\">SDOHCC Observation Race OMB</a><br/>��<a href=\"StructureDefinition-SDOHCC-ObservationGenderIdentity.html\">SDOHCC Observation Gender Identity</a><br/>��<a href=\"StructureDefinition-SDOHCC-ObservationPersonalCharacteristic.html\">SDOHCC Observation Personal Characteristic</a><br/>��<a href=\"StructureDefinition-SDOHCC-ObservationPersonalPronouns.html\">SDOHCC Observation Personal Pronouns</a><br/>��<a href=\"StructureDefinition-SDOHCC-ObservationRecordedSexGender.html\">SDOHCC Observation Recorded Sex Gender</a><br/>��<a href=\"StructureDefinition-SDOHCC-ObservationSexualOrientation.html\">SDOHCC Observation Sexual Orientation</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated, category, code, code-value-concept, date, derived-from, patient, status</td><td/><td/><td/></tr><tr><td><a href=\"#Organization1-10\">Organization</a></td><td>Supported Profiles<br/>��<a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-organization.html\">US Core Organization Profile</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated</td><td/><td/><td/></tr><tr><td><a href=\"#Patient1-11\">Patient</a></td><td>Supported Profiles<br/>��<a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-patient.html\">US Core Patient Profile</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated</td><td/><td/><td/></tr><tr><td><a href=\"#Practitioner1-12\">Practitioner</a></td><td>Supported Profiles<br/>��<a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitioner.html\">US Core Practitioner Profile</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated</td><td/><td/><td/></tr><tr><td><a href=\"#PractitionerRole1-13\">PractitionerRole</a></td><td>Supported Profiles<br/>��<a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitionerrole.html\">US Core PractitionerRole Profile</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated, organization, practitioner</td><td><code>PractitionerRole:organization</code>, <code>PractitionerRole:practitioner</code></td><td/><td/></tr><tr><td><a href=\"#Procedure1-14\">Procedure</a></td><td>Supported Profiles<br/>��<a href=\"StructureDefinition-SDOHCC-Procedure.html\">SDOHCC Procedure</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td>_id, _lastUpdated, based-on, category, code, date, patient, performer, status</td><td/><td/><td/></tr><tr><td><a href=\"#RelatedPerson1-15\">RelatedPerson</a></td><td>Supported Profiles<br/>��<a href=\"http://hl7.org/fhir/R4/relatedperson.html\">RelatedPerson</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated</td><td/><td/><td/></tr><tr><td><a href=\"#ServiceRequest1-16\">ServiceRequest</a></td><td>Supported Profiles<br/>��<a href=\"StructureDefinition-SDOHCC-ServiceRequest.html\">SDOHCC ServiceRequest</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated, category, code, intent, occurrence, patient, performer, requester, status, supporting-info</td><td><code>HealthCareService:location</code>, <code>ServiceRequest:supporting-info</code>, <code>ServiceRequest:pertains-to-goal</code>, <code>ServiceRequest:patient</code>, <code>ServiceRequest:requester</code>, <code>ServiceRequest:performer</code>, <code>PractitionerRole:practitioner</code>, <code>PractitionerRole:organization</code></td><td/><td/></tr><tr><td><a href=\"#Subscription1-17\">Subscription</a></td><td>Supported Profiles<br/>��<a href=\"http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription.html\">R4/B Topic-Based Subscription</a></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td></td><td/><td/><td><code>$status</code></td></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"CareTeam1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>CareTeam</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/careteam.html\">CareTeam</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>MAY</strong> support <br/><code>read</code><div><p>Allows the system to retrieve a CareTeam that is the intended performer of a ServiceRequest.</p>\n</div><code>search-type</code><div><p>Allows the monitoring of previously-retrieved CareTeams that are the intended performer of ServiceRequests.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-careteam.html\">US Core CareTeam Profile</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>For referral sources that receive referrals from upstream systems, used to access information about the intended performer of a ServiceRequest when the performer is a specific team of people. Note: Conformance expectations for this resource are lower because CareTeam performers are expected to be uncommon in most SDOH uses</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieving known CareTeam records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Allows filtering for only records that have changed since last query</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"Condition1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Condition</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/condition.html\">Condition</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>read</code><div><p>Allows the system to retrieve a Condition that is the reason for a ServiceRequest.</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>search-type</code><div><p>Allows the monitoring of previously-retrieved Conditions that are referenced by ServiceRequests.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-SDOHCC-Condition.html\">SDOHCC Condition</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>For referral sources that receive referrals from upstream systems, used to access information about a patient's SDOH-related conditions, particularly those that are the reason for a referral</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieving known Condition records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">category</a></td><td><code>token</code></td><td><div><p>Allows filtering to only SDOH-related conditions</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Allows filtering to only conditions associated with a specific patient. Some systems will require that searches be patient-specific</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Allows filtering for only records that have changed since last query</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">clinical-status</a></td><td><code>token</code></td><td><div><p>Allows filtering to only active conditions</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">code</a></td><td><code>token</code></td><td><div><p>Allows filtering to only specific SDOH conditions or sets of conditions</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">verification-status</a></td><td><code>token</code></td><td><div><p>Allows filtering to exclude refuted or entered-in-error conditions</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"Consent1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Consent</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/consent.html\">Consent</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>read</code><div><p>Allows the system to retrieve a Consent referenced as a 'supportingInformation' item of a ServiceRequest.</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>search-type</code><div><p>Allows the monitoring of previously-retrieved Consents related to ServiceRequests of interest.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-SDOHCC-Consent.html\">SDOHCC Consent</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Used to access the consent that authorizes disclosure of ServiceRequest information to non-HIPAA-covered entities</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieving known consent records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/consent.html#search\">source-reference</a></td><td><code>reference</code></td><td><div><p>Allows including the document that contains the PDF or similar representation of a paper consent</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Allows filtering for only records that have changed since last query</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"Device1-4\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Device</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/device.html\">Device</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <br/><code>read</code><div><p>Allows the system to retrieve a Device that is the requester or intended performer of a ServiceRequest.</p>\n</div><code>search-type</code><div><p>Allows the monitoring of previously-retrieved Devices that are the requester or intended performer of ServiceRequests.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/R4/device.html\">Device</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Used to retrieve the requester or intended performer of an SDOH ServiceRequest. Note: Conformance expectations for this resource are lower because Device requesters and performers are expected to be uncommon in most SDOH uses</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieving known Device records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Allows filtering for only records that have changed since last query</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"DocumentReference1-5\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>DocumentReference</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/documentreference.html\">DocumentReference</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>read</code><div><p>Allows the system to retrieve a PDF or similar content referenced by a Consent or Task.</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>search-type</code><div><p>Allows the monitoring of previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-documentreference.html\">US Core DocumentReference Profile</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Used to retrieve a scanned or other form of document representing the text of a consent. Also used for PDF forms.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Allows filtering for only records that have changed since last query</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"Goal1-6\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Goal</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/goal.html\">Goal</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>read</code><div><p>Allows the system to retrieve a goal referenced by a ServiceRequest.</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>search-type</code><div><p>Allows the monitoring of previously-retrieved Goals in the event they are updated.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-SDOHCC-Goal.html\">SDOHCC Goal</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Used to access goals related to an SDOH referral</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieving known Goal records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/goal.html#search\">category</a></td><td><code>token</code></td><td><div><p>Allows filtering to only include SDOH-related goals</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/goal.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Allows filtering to only include goals for a particular patient. Some systems will require searches to be patient-specific</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Allows filtering for only records that have changed since last query</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/goal.html#search\">achievement-status</a></td><td><code>token</code></td><td><div><p>Allows filtering to only include unmet goals</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/goal.html#search\">lifecycle-status</a></td><td><code>token</code></td><td><div><p>Allows filtering to only include active goals</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/goal.html#search\">target-date</a></td><td><code>date</code></td><td><div><p>Allows filtering based on when a particular goal is desired to be achieved</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"HealthcareService1-7\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>HealthcareService</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/healthcareservice.html\">HealthcareService</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <br/><code>read</code><div><p>Allows the system to retrieve a HealthcareService that is the intended performer of a ServiceRequest.</p>\n</div><code>search-type</code><div><p>Allows the monitoring of previously-retrieved HealthcareServices that are the intended performer of ServiceRequests.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-SDOHCC-HealthcareService.html\">SDOHCC Healthcare Service</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>For referral sources that receive referrals from upstream systems, used to access information about the intended performer of a ServiceRequest when the performer is a specific service within a larger facility. Also used to indicate who a patient or caregiver should contact about a particular service.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieving known HealthcareService records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/healthcareservice.html#search\">location</a></td><td><code>reference</code></td><td><div><p>Allows retrieval of the phyical site(s) associated with a HealthService</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Allows filtering for only records that have changed since last query</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"Location1-8\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Location</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/location.html\">Location</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <br/><code>read</code><div><p>Allows the system to retrieve a Location that is an available location for a service.</p>\n</div></li><li><strong>MAY</strong> support <br/><code>search-type</code><div><p>Allows the monitoring of previously-retrieved Locations that are the intended locations for services.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-SDOHCC-Location.html\">SDOHCC Location</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Used to access information about the potential sites at which a requested service might be performed. Allows a patient to evaluate the suitability of a proposed activity or service.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieving known Location records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Allows filtering for only records that have changed since last query</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"Observation1-9\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Observation</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/observation.html\">Observation</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>read</code><div><p>Allows the system to retrieve an Observation referenced by a ServiceRequest.</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>search-type</code><div><p>Allows the monitoring of previously-retrieved Observations for updates/corrections.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-SDOHCC-ObservationAssessment.html\">SDOHCC Observation Assessment</a><br/><a href=\"StructureDefinition-SDOHCC-ObservationScreeningResponse.html\">SDOHCC Observation Screening Response</a><br/><a href=\"StructureDefinition-SDOHCC-ObservationEthnicityOMB.html\">SDOHCC Observation Ethnicity OMB</a><br/><a href=\"StructureDefinition-SDOHCC-ObservationRaceOMB.html\">SDOHCC Observation Race OMB</a><br/><a href=\"StructureDefinition-SDOHCC-ObservationGenderIdentity.html\">SDOHCC Observation Gender Identity</a><br/><a href=\"StructureDefinition-SDOHCC-ObservationPersonalCharacteristic.html\">SDOHCC Observation Personal Characteristic</a><br/><a href=\"StructureDefinition-SDOHCC-ObservationPersonalPronouns.html\">SDOHCC Observation Personal Pronouns</a><br/><a href=\"StructureDefinition-SDOHCC-ObservationRecordedSexGender.html\">SDOHCC Observation Recorded Sex Gender</a><br/><a href=\"StructureDefinition-SDOHCC-ObservationSexualOrientation.html\">SDOHCC Observation Sexual Orientation</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>For referral sources that receive referrals from upstream systems, used to access information about SDOH-related observations for a patient - particularly those that are reasons for a referral as well as certain SDOH-relevant demographic information</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieving known Observation records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">category</a></td><td><code>token</code></td><td><div><p>Allows filtering for only SDOH-related observations</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Allows filtering for observations specific to a particular patient. Some systems will require that all queries be patient-specific</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">status</a></td><td><code>token</code></td><td><div><p>Allows filtering for observations that are completed or revised (i.e. not in-progress or entered-in-error)</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Allows filtering for only records that have changed since last query</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">code</a></td><td><code>token</code></td><td><div><p>Allows filtering for specific types of observations</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">date</a></td><td><code>date</code></td><td><div><p>Allows filtering for observations that held in a particular time period</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">derived-from</a></td><td><code>reference</code></td><td><div><p>Allows filtering for observations derived from a particular QuestionnaireResponse</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">code-value-concept</a></td><td><code>composite</code></td><td><div><p>Allows filtering for observations that have a specific coded value answer for a specified observation type</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"Organization1-10\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Organization</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/organization.html\">Organization</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>read</code><div><p>Allows the system to retrieve an Organization that is the requester or intended performer of a ServiceRequest.</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>search-type</code><div><p>Allows the monitoring of previously-retrieved Organizations that are the requester or intended performer of ServiceRequests.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-organization.html\">US Core Organization Profile</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>For referral sources that receive referrals from upstream systems, used to access information about an Organization that is the requester or intended performer of a ServiceRequest</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieving known Organization records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Allows filtering for only records that have changed since last query</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"Patient1-11\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Patient</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>read</code><div><p>Allows the system to retrieve the Patient that is the subject of a ServiceRequest.</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>search-type</code><div><p>Allows the monitoring of previously-retrieved Patients.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-patient.html\">US Core Patient Profile</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>For referral sources that receive referrals from upstream systems, used to access information about the Patient that is the subject a ServiceRequest</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieving known Patient records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Allows filtering for only records that have changed since last query</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"Practitioner1-12\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Practitioner</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/practitioner.html\">Practitioner</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>read</code><div><p>Allows the system to retrieve a Practitioner that is the requester or intended performer of a ServiceRequest.</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>search-type</code><div><p>Allows the monitoring of previously-retrieved Practitioners that are the requester or intended performer of ServiceRequests.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitioner.html\">US Core Practitioner Profile</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>For referral sources that receive referrals from upstream systems, used to access information about an Practitioner that is the requester or intended performer of a ServiceRequest</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieving known Practitioner records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Allows filtering for only records that have changed since last query</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"PractitionerRole1-13\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>PractitionerRole</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/practitionerrole.html\">PractitionerRole</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>read</code><div><p>Allows the system to retrieve a PractitionerRole that is the requester or intended performer of a ServiceRequest.</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>search-type</code><div><p>Allows the monitoring of previously-retrieved PractitionerRoles that are the requester or intended performer of ServiceRequests.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitionerrole.html\">US Core PractitionerRole Profile</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>For referral sources that receive referrals from upstream systems, used to access information about an PractitionerRole that is the requester or intended performer of a ServiceRequest</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieving known PractitionerRole records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Allows filtering for only records that have changed since last query</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/practitionerrole.html#search\">organization</a></td><td><code>reference</code></td><td><div><p>Allows doing an _include on Organization when retrieving the PractitionerRole</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/practitionerrole.html#search\">practitioner</a></td><td><code>reference</code></td><td><div><p>Allows doing an _include on Practitioner when retrieving the PractitionerRole</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"Procedure1-14\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Procedure</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/procedure.html\">Procedure</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>create</code><div><p>Allows the system to write records of procedures done in response to a referral on the system that asked for the referral.</p>\n</div><code>update</code><div><p>Allows the system to update records of procedures done in response to a referral on the system that asked for the referral.</p>\n</div><code>read</code><div><p>Allows the referral recipient to retrieve procedures referenced by Tasks previously posted.</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>search-type</code><div><p>Allows the referral recipient to check if others have updated (e.g. added comments) to procedures previously posted and/or to find previously submitted procedures so they can be rendered to a user.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-SDOHCC-Procedure.html\">SDOHCC Procedure</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Used to record information about actions that have been performed as a result of a referral</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieving known Procedure records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">based-on</a></td><td><code>reference</code></td><td><div><p>Allows filtering for procedures resulting from a particular service request</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">category</a></td><td><code>token</code></td><td><div><p>Allows filtering for procedures that are SDOH-related</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Allows filtering for procedures based on who they were delivered to. Some systems may require that all searches be patient-specific.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">performer</a></td><td><code>reference</code></td><td><div><p>Allows filtering for procedures based on who delivered the procedure.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">status</a></td><td><code>token</code></td><td><div><p>Allows filtering for procedures that are complete or in progress</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Allows filtering for only records that have changed since last query</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">code</a></td><td><code>token</code></td><td><div><p>Allows filtering for procedures based on the specific service delivered</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/procedure.html#search\">date</a></td><td><code>date</code></td><td><div><p>Allows filtering for procedures based on when they were delivered</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"RelatedPerson1-15\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>RelatedPerson</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/relatedperson.html\">RelatedPerson</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>MAY</strong> support <br/><code>read</code><div><p>Allows the system to retrieve a RelatedPerson that is the requester or intended performer of a ServiceRequest.</p>\n</div><code>search-type</code><div><p>Allows the monitoring of previously-retrieved RelatedPersons that are the requester or intended performer of ServiceRequests.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/R4/relatedperson.html\">RelatedPerson</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>For referral sources that receive referrals from upstream systems, used to access information about the requester or intended performer of a ServiceRequest when they are someone with a personal relationship to the Patient. Note: Conformance expectations for this resource are lower because CareTeam performers are expected to be uncommon in most SDOH uses</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieving known RelatedPerson records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Allows filtering for only records that have changed since last query</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"ServiceRequest1-16\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>ServiceRequest</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/servicerequest.html\">ServiceRequest</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>read</code><div><p>Allows client systems to retrieve the ServiceRequest pointed to by a Task.</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>search-type</code><div><p>Allows client systems to monitor multiple ServiceRequests for change simultaneously via polling.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-SDOHCC-ServiceRequest.html\">SDOHCC ServiceRequest</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>For referral sources that receive referrals from upstream systems, used to retrieve an order for SDOH-related services</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieving known ServiceRequests records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">category</a></td><td><code>token</code></td><td><div><p>Allows filtering to only retrieve ServiceRequests that are SDOH-related</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">intent</a></td><td><code>token</code></td><td><div><p>Allows filtering to retrieve only 'order' ServiceRequests and not plans, proposals, etc.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Allows filtering to retrieve only ServiceRequests associated with a particular patient. Note that some systems may mandate that searches are always patient-specific</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">status</a></td><td><code>token</code></td><td><div><p>Allows filtering to retrieve only active ServiceRequests</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Allows filtering for only records that have changed since last query</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">code</a></td><td><code>token</code></td><td><div><p>Allows filtering to retrieve ServiceRequests for specific types of services</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">occurrence</a></td><td><code>date</code></td><td><div><p>Allows filtering to retrieve ServiceRequests based on the timeframe in which the service needs to be provided</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">performer</a></td><td><code>reference</code></td><td><div><p>Allows filtering to retrieve only ServiceRequests that designate a specific performer</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/servicerequest.html#search\">requester</a></td><td><code>reference</code></td><td><div><p>Allows filtering to retrieve only ServiceRequests created by a specific practitioner</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"SearchParameter-ServiceRequest-supporting-info.html\">supporting-info</a></td><td><code>reference</code></td><td><div><p>Allows _include to retrieve supporting information for a ServiceRequest - particularly Consent</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"Subscription1-17\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Subscription</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/subscription.html\">Subscription</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <br/><code>create</code><div><p>Necessary if using subscriptions to monitor updates to the Task</p>\n</div></li><li><strong>MAY</strong> support <br/><code>update</code><div><p>Needed to allow the requester to update a subscription - to adjust delivery target, to add additional tasks to monitor (if subscribing by id) typically to cancel a request for fulfillment</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription.html\">R4/B Topic-Based Subscription</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Used to allow upstream systems to subscribe to and monitor Tasks stored on this system for change</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/OperationDefinition-backport-subscription-status.html\">$status</a></td><td><div><p>Necessary for systems supporting subscriptions to ensure that the subscription is functioning properly and to check for errors</p>\n</div></td></tr></tbody></table></div></div></div></div></div><h3 id=\"rest2\">REST Configuration: 2 </h3><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"mode2\" class=\"panel-title\">Mode: <code>server</code></h4></div><div class=\"panel-body\"><div><p>The clinical care referral recipient needs to allow SDOH clinical care <a href=\"CapabilityStatement-SDOHCC-ReferralSource.html\">referral sources</a> and <a href=\"CapabilityStatement-SDOHCC-CoordinationPlatform.html\">coordination platforms</a> to have solicited the filling of SDOH-related referrals by this system and also to access Procedures that describe interventions taken by the users of this system.</p>\n</div><div class=\"lead\"><em>Security</em></div><div class=\"row\"><div class=\"col-lg-6\">Enable CORS: no</div><div class=\"col-lg-6\">Security services supported: <code>SMART-on-FHIR</code></div></div><blockquote><div><p>Implementations must meet the general privacy & security requirements documented in <a href=\"privacy_and_security.html\">this implementation guide</a>.</p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li><strong>SHOULD </strong>support the <code>batch</code>interaction described as follows:<div><p>Allows other systems to poll for changes to multiple resource types simultaneously</p>\n</div></li></ul></div></div><h4 id=\"resourcesCap2\">Capabilities by Resource/Profile</h4><h5 id=\"resourcesSummary2\">Summary</h5><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#DocumentReference2-1\">DocumentReference</a></td><td>Supported Profiles<br/>��<a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-documentreference.html\">US Core DocumentReference Profile</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td>_id, _lastUpdated</td><td/><td/><td/></tr><tr><td><a href=\"#Subscription2-2\">Subscription</a></td><td>Supported Profiles<br/>��<a href=\"http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription.html\">R4/B Topic-Based Subscription</a></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td></td><td/><td/><td><code>$status</code></td></tr><tr><td><a href=\"#Task2-3\">Task</a></td><td>Supported Profiles<br/>��<a href=\"StructureDefinition-SDOHCC-TaskForPatient.html\">SDOHCC Task For Patient</a><br/>��<a href=\"StructureDefinition-SDOHCC-TaskForReferralManagement.html\">SDOHCC Task For Referral Management</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td>_id, _lastUpdated, code, owner, patient, requester, status, focus, output</td><td><code>Task:output</code></td><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"DocumentReference2-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>DocumentReference</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/documentreference.html\">DocumentReference</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>create</code><div><p>Allows the app to record a new PDF (e.g. a completed form)</p>\n</div><code>read</code><div><p>Allows patient apps to retrieve a PDF or similar content referenced by a Consent or Task.</p>\n</div><code>search-type</code><div><p>Allows patient apps to monitor previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated.</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>update</code><div><p>Allows the system to revise a previously stored PDF</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-documentreference.html\">US Core DocumentReference Profile</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Used convey a scanned or other form of document representing the text of a consent. Also used for PDF forms.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Allows filtering for only records that have changed since last query</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"Subscription2-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Subscription</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/subscription.html\">Subscription</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHOULD</strong> support <br/><code>create</code><div><p>Allows upstream systems to initiate a subscription to monitor updates to Tasks (and theoretically other things)</p>\n</div></li><li><strong>MAY</strong> support <br/><code>update</code><div><p>Allows upstream systems to revise existing subscriptions - to adjust delivery target, to add additional tasks to monitor (if subscribing by id), etc.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/StructureDefinition-backport-subscription.html\">R4/B Topic-Based Subscription</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Used to allow upstream coordination platforms and referral sources to subscribe to and monitor Tasks created on this system</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/uv/subscriptions-backport/STU1.1/OperationDefinition-backport-subscription-status.html\">$status</a></td><td><div><p>Allows upstream systems to verify their subscription is functioning properly and to check for errors</p>\n</div></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h5 id=\"Task2-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Task</h5></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/task.html\">Task</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/><code>literal</code></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>create</code><div><p>Allows upstream coordination platforms and referral sources system to create tasks on this system seeking fulfillment of a ServiceRequest or requesting that a patient or caregiver perform certain activities.</p>\n</div><code>update</code><div><p>Allows modification of an existing Task by upstream systems (e.g. to cancel it) or by downstream systems (to accept or reject it or add output links to performed procedures). ReferralRecipients can freely modify any Tasks they have created (though they should consider the impact of doing so on downstream recipients or the patient). However, if they are not the creator, they SHALL only modify tasks they are the 'owner' of and then, only modify Task.status, Task.statusReason, and Task.outputs are possible, and then only for Tasks where the owner is the patient.</p>\n</div><code>read</code><div><p>Allows retrieval of a Task that was referenced in a subscription notification or per-Task polling for change.</p>\n</div><code>search-type</code><div><p>Allows the other systems to poll multiple tasks simultaneously, as well as to retrieve referenced resources as part of a single query.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-SDOHCC-TaskForPatient.html\">SDOHCC Task For Patient</a><br/><a href=\"StructureDefinition-SDOHCC-TaskForReferralManagement.html\">SDOHCC Task For Referral Management</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Used by upstream referral sources and coordination platforms to create and update Tasks seeking fufillment of ServiceRequests. Also used by downstream referral recipiencts to monitor and update Tasks stored on this system as they respond to requests to fulfill referrals and link in information about actions taken so far</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Allows retrieving known Task records - and more specifically, retrieving more than one in a single call to poll for updates</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/task.html#search\">code</a></td><td><code>token</code></td><td><div><p>Allows filtering for 'fulfill' tasks as opposed to others. Some systems may require code to be included as a filter criteria as different Task codes may correspond to different internal database tables.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/task.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Allows monitoring of tasks associated with a particular patient. (Some systems may require that all queries be done in the context of a single patient.)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/task.html#search\">requester</a></td><td><code>reference</code></td><td><div><p>Allows retrieving all tasks that have been requested by a particular organization or individual. This will commonly be used to monitor the tasks initiated by a particular system</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/task.html#search\">status</a></td><td><code>token</code></td><td><div><p>Allows filtering to only active or completed tasks</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/task.html#search\">focus</a></td><td><code>reference</code></td><td><div><p>Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Allows filtering for only records that have changed since last query</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/task.html#search\">owner</a></td><td><code>reference</code></td><td><div><p>Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned)</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"SearchParameter-Task-output-reference.html\">output</a></td><td><code>reference</code></td><td><div><p>Allows for the 'output' of a Task to be included when retrieving a Task</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "pc"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/sdoh-clinicalcare/ImplementationGuide/hl7.fhir.us.sdoh-clinicalcare"
}
]
}
}
],
"url" : "http://hl7.org/fhir/us/sdoh-clinicalcare/CapabilityStatement/SDOHCC-ReferralRecipient",
"version" : "2.2.0",
"name" : "SDOHCC_ReferralRecipient",
"title" : "SDOHCC Referral Recipient",
"status" : "active",
"date" : "2021-06",
"publisher" : "HL7 International / Patient Care",
"contact" : [
{
"name" : "HL7 International / Patient Care",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/patientcare"
},
{
"system" : "email",
"value" : "patientcare@lists.hl7.org"
}
]
}
],
"description" : "This resource describes the required and desired behavior of systems acting as SDOH clinical care 'referral recipients'. These are typically community-based organizations that can provide services such as food bank access, housing remediation, etc.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US",
"display" : "United States of America"
}
]
}
],
"purpose" : "In some cases, a referral recipient might actually further refer the patient to a downstream service provider through non-FHIR means. In such cases, the system is still treated as a 'referral recipient' rather than a [Coordination Platform](CapabilityStatement-SDOHCC-CoordinationPlatform.html) because, from a FHIR interface perspective, the referral process 'stops' with that system. Referral recipients must be able to receive or monitor for Tasks issued by [Referral Sources](CapabilityStatement-SDOHCC-ReferralSource.html) and [Coordination Platforms](CapabilityStatement-SDOHCC-CoordinationPlatform.html). They must also be able to respond to access the ServiceRequest representing the referral pointed to by the Task and any relevant information referenced by the referral, update the Task with their acceptance or rejection of the referral, and finally provide information about what interventions were actually performed using the Procedure resource.\\n\\n There are actually two types of referral recipients defined in this implementation guide. This CapabilityStatement describes the expected behavior of more sophisticated service delivery systems that are capable of exposing a FHIR service and persisting Tasks and Procedures in their own environment. A separate set of interface expectations is defined for ['Light' Referral Recipients](CapabilityStatement-SDOHCC-ReferralRecipientLight.html) that are not capable of exposing an endpoint and where the Task and any resulting Procedures must be stored in the requesting system's database.",
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"xml",
"json"
],
"rest" : [
{
"mode" : "client",
"documentation" : "The clinical care referral recipient needs to access information from and update information in SDOH clinical care [referral sources](CapabilityStatement-SDOHCC-ReferralSource.html) and/or [coordination platforms](CapabilityStatement-SDOHCC-CoordinationPlatform.html) that have solicited the filling of SDOH-related referrals by this system",
"security" : {
"service" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code" : "SMART-on-FHIR"
}
]
}
],
"description" : "Implementations must meet the general privacy & security requirements documented in [this implementation guide](privacy_and_security.html)."
},
"resource" : [
{
"type" : "CareTeam",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "For referral sources that receive referrals from upstream systems, used to access information about the intended performer of a ServiceRequest when the performer is a specific team of people. Note: Conformance expectations for this resource are lower because CareTeam performers are expected to be uncommon in most SDOH uses",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a CareTeam that is the intended performer of a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved CareTeams that are the intended performer of ServiceRequests."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known CareTeam records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
}
]
},
{
"type" : "Condition",
"supportedProfile" : [
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Condition"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "For referral sources that receive referrals from upstream systems, used to access information about a patient's SDOH-related conditions, particularly those that are the reason for a referral",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a Condition that is the reason for a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved Conditions that are referenced by ServiceRequests."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known Condition records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-category",
"type" : "token",
"documentation" : "Allows filtering to only SDOH-related conditions"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "clinical-status",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-clinical-status",
"type" : "token",
"documentation" : "Allows filtering to only active conditions"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Allows filtering to only specific SDOH conditions or sets of conditions"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Allows filtering to only conditions associated with a specific patient. Some systems will require that searches be patient-specific"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "verification-status",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-verification-status",
"type" : "token",
"documentation" : "Allows filtering to exclude refuted or entered-in-error conditions"
}
]
},
{
"type" : "Consent",
"supportedProfile" : [
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Consent"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Used to access the consent that authorizes disclosure of ServiceRequest information to non-HIPAA-covered entities",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a Consent referenced as a 'supportingInformation' item of a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved Consents related to ServiceRequests of interest."
}
],
"referencePolicy" : [
"literal"
],
"searchInclude" : [
"Consent:source-reference:DocumentReference"
],
"_searchInclude" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known consent records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "source-reference",
"definition" : "http://hl7.org/fhir/SearchParameter/Consent-source-reference",
"type" : "reference",
"documentation" : "Allows including the document that contains the PDF or similar representation of a paper consent"
}
]
},
{
"type" : "Device",
"supportedProfile" : [
"http://hl7.org/fhir/StructureDefinition/Device"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Used to retrieve the requester or intended performer of an SDOH ServiceRequest. Note: Conformance expectations for this resource are lower because Device requesters and performers are expected to be uncommon in most SDOH uses",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a Device that is the requester or intended performer of a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved Devices that are the requester or intended performer of ServiceRequests."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known Device records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
}
]
},
{
"type" : "DocumentReference",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Used to retrieve a scanned or other form of document representing the text of a consent. Also used for PDF forms.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a PDF or similar content referenced by a Consent or Task."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
}
]
},
{
"type" : "Goal",
"supportedProfile" : [
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Goal"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Used to access goals related to an SDOH referral",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a goal referenced by a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved Goals in the event they are updated."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known Goal records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "achievement-status",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-achievement-status",
"type" : "token",
"documentation" : "Allows filtering to only include unmet goals"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-category",
"type" : "token",
"documentation" : "Allows filtering to only include SDOH-related goals"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "lifecycle-status",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-lifecycle-status",
"type" : "token",
"documentation" : "Allows filtering to only include active goals"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Allows filtering to only include goals for a particular patient. Some systems will require searches to be patient-specific"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "target-date",
"definition" : "http://hl7.org/fhir/SearchParameter/Goal-target-date",
"type" : "date",
"documentation" : "Allows filtering based on when a particular goal is desired to be achieved"
}
]
},
{
"type" : "HealthcareService",
"supportedProfile" : [
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-HealthcareService"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "For referral sources that receive referrals from upstream systems, used to access information about the intended performer of a ServiceRequest when the performer is a specific service within a larger facility. Also used to indicate who a patient or caregiver should contact about a particular service.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a HealthcareService that is the intended performer of a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved HealthcareServices that are the intended performer of ServiceRequests."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known HealthcareService records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "location",
"definition" : "http://hl7.org/fhir/SearchParameter/HealthcareService-location",
"type" : "reference",
"documentation" : "Allows retrieval of the phyical site(s) associated with a HealthService"
}
]
},
{
"type" : "Location",
"supportedProfile" : [
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-Location"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Used to access information about the potential sites at which a requested service might be performed. Allows a patient to evaluate the suitability of a proposed activity or service.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve a Location that is an available location for a service."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved Locations that are the intended locations for services."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known Location records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
}
]
},
{
"type" : "Observation",
"supportedProfile" : [
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationAssessment",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationScreeningResponse",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationEthnicityOMB",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationRaceOMB",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationGenderIdentity",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationPersonalCharacteristic",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationPersonalPronouns",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationRecordedSexGender",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-ObservationSexualOrientation"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
}
],
"documentation" : "For referral sources that receive referrals from upstream systems, used to access information about SDOH-related observations for a patient - particularly those that are reasons for a referral as well as certain SDOH-relevant demographic information",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows the system to retrieve an Observation referenced by a ServiceRequest."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type",
"documentation" : "Allows the monitoring of previously-retrieved Observations for updates/corrections."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known Observation records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-category",
"type" : "token",
"documentation" : "Allows filtering for only SDOH-related observations"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Allows filtering for specific types of observations"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "code-value-concept",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-code-value-concept",
"type" : "composite",
"documentation" : "Allows filtering for observations that have a specific coded value answer for a specified observation type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Allows filtering for observations that held in a particular time period"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "derived-from",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-derived-from",
"type" : "reference",
"documentation" : "Allows filtering for observations derived from a particular QuestionnaireResponse"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Allows filtering for observations specific to a particular patient. Some systems will require that all queries be patient-specific"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-status",
"type" : "token",
"documentation" : "Allows filtering for observations that are completed or revised (i.e. not in-progress or entered-in-error)"
}
]
},
{
"type" : "Organization",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "For referral sources that receive referrals from upstream systems, used to access information about an Organization that is the requester or intended performer of a ServiceRequest",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
& "definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Allows filtering to retrieve ServiceRequests for specific types of services"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "intent",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-intent",
"type" : "token",
"documentation" : "Allows filtering to retrieve only 'order' ServiceRequests and not plans, proposals, etc."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "occurrence",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-occurrence",
"type" : "date",
"documentation" : "Allows filtering to retrieve ServiceRequests based on the timeframe in which the service needs to be provided"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Allows filtering to retrieve only ServiceRequests associated with a particular patient. Note that some systems may mandate that searches are always patient-specific"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "performer",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-performer",
"type" : "reference",
"documentation" : "Allows filtering to retrieve only ServiceRequests that designate a specific performer"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "requester",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-requester",
"type" : "reference",
"documentation" : "Allows filtering to retrieve only ServiceRequests created by a specific practitioner"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ServiceRequest-status",
"type" : "token",
"documentation" : "Allows filtering to retrieve only active ServiceRequests"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "supporting-info",
"definition" : "http://hl7.org/fhir/us/sdoh-clinicalcare/SearchParameter/ServiceRequest-supporting-info",
"type" : "reference",
"documentation" : "Allows _include to retrieve supporting information for a ServiceRequest - particularly Consent"
}
]
},
{
"type" : "Subscription",
"supportedProfile" : [
"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Used to allow upstream systems to subscribe to and monitor Tasks stored on this system for change",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create",
"documentation" : "Necessary if using subscriptions to monitor updates to the Task"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update",
"documentation" : "Needed to allow the requester to update a subscription - to adjust delivery target, to add additional tasks to monitor (if subscribing by id) typically to cancel a request for fulfillment"
}
],
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status",
"documentation" : "Necessary for systems supporting subscriptions to ensure that the subscription is functioning properly and to check for errors"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "batch",
"documentation" : "Allows polling for changes to multiple resource types simultaneously"
}
]
},
{
"mode" : "server",
"documentation" : "The clinical care referral recipient needs to allow SDOH clinical care [referral sources](CapabilityStatement-SDOHCC-ReferralSource.html) and [coordination platforms](CapabilityStatement-SDOHCC-CoordinationPlatform.html) to have solicited the filling of SDOH-related referrals by this system and also to access Procedures that describe interventions taken by the users of this system.",
"security" : {
"service" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code" : "SMART-on-FHIR"
}
]
}
],
"description" : "Implementations must meet the general privacy & security requirements documented in [this implementation guide](privacy_and_security.html)."
},
"resource" : [
{
"type" : "DocumentReference",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Used convey a scanned or other form of document representing the text of a consent. Also used for PDF forms.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "create",
"documentation" : "Allows the app to record a new PDF (e.g. a completed form)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update",
"documentation" : "Allows the system to revise a previously stored PDF"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows patient apps to retrieve a PDF or similar content referenced by a Consent or Task."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows patient apps to monitor previously-retrieved DocumentReferences in the event the image/document is amended/corrected/updated."
}
],
"referencePolicy" : [
"literal"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known DocumentReference records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
}
]
},
{
"type" : "Subscription",
"supportedProfile" : [
"http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Used to allow upstream coordination platforms and referral sources to subscribe to and monitor Tasks created on this system",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create",
"documentation" : "Allows upstream systems to initiate a subscription to monitor updates to Tasks (and theoretically other things)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update",
"documentation" : "Allows upstream systems to revise existing subscriptions - to adjust delivery target, to add additional tasks to monitor (if subscribing by id), etc."
}
],
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/uv/subscriptions-backport/OperationDefinition/backport-subscription-status",
"documentation" : "Allows upstream systems to verify their subscription is functioning properly and to check for errors"
}
]
},
{
"type" : "Task",
"supportedProfile" : [
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForPatient",
"http://hl7.org/fhir/us/sdoh-clinicalcare/StructureDefinition/SDOHCC-TaskForReferralManagement"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Used by upstream referral sources and coordination platforms to create and update Tasks seeking fufillment of ServiceRequests. Also used by downstream referral recipiencts to monitor and update Tasks stored on this system as they respond to requests to fulfill referrals and link in information about actions taken so far",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "create",
"documentation" : "Allows upstream coordination platforms and referral sources system to create tasks on this system seeking fulfillment of a ServiceRequest or requesting that a patient or caregiver perform certain activities."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "update",
"documentation" : "Allows modification of an existing Task by upstream systems (e.g. to cancel it) or by downstream systems (to accept or reject it or add output links to performed procedures). ReferralRecipients can freely modify any Tasks they have created (though they should consider the impact of doing so on downstream recipients or the patient). However, if they are not the creator, they SHALL only modify tasks they are the 'owner' of and then, only modify Task.status, Task.statusReason, and Task.outputs are possible, and then only for Tasks where the owner is the patient."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Allows retrieval of a Task that was referenced in a subscription notification or per-Task polling for change."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Allows the other systems to poll multiple tasks simultaneously, as well as to retrieve referenced resources as part of a single query."
}
],
"versioning" : "versioned-update",
"conditionalRead" : "modified-since",
"referencePolicy" : [
"literal"
],
"searchInclude" : [
"Task:output"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Allows retrieving known Task records - and more specifically, retrieving more than one in a single call to poll for updates"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Allows filtering for only records that have changed since last query"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-code",
"type" : "token",
"documentation" : "Allows filtering for 'fulfill' tasks as opposed to others. Some systems may require code to be included as a filter criteria as different Task codes may correspond to different internal database tables."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "owner",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-owner",
"type" : "reference",
"documentation" : "Allows filtering only for tasks that are assigned to a particular owner (or alternatively, tasks that have not yet been assigned)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-patient",
"type" : "reference",
"documentation" : "Allows monitoring of tasks associated with a particular patient. (Some systems may require that all queries be done in the context of a single patient.)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "requester",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-requester",
"type" : "reference",
"documentation" : "Allows retrieving all tasks that have been requested by a particular organization or individual. This will commonly be used to monitor the tasks initiated by a particular system"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-status",
"type" : "token",
"documentation" : "Allows filtering to only active or completed tasks"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "focus",
"definition" : "http://hl7.org/fhir/SearchParameter/Task-focus",
"type" : "reference",
"documentation" : "Allows retrieving the task(s) seeking fulfillment of a particular ServiceRequest"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "output",
"definition" : "http://hl7.org/fhir/us/sdoh-clinicalcare/SearchParameter/Task-output-reference",
"type" : "reference",
"documentation" : "Allows for the 'output' of a Task to be included when retrieving a Task"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "batch",
"documentation" : "Allows other systems to poll for changes to multiple resource types simultaneously"
}
]
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.